Artemis Trouble Ticket API

This section defines the key fields used in the TMF621 Trouble Ticket API. Attributes listed here may appear in request or response payloads depending on the operation. Fields are derived from TMF621 v5.0.0 and follow TMF630 REST design principles.

API request payload

This endpoint returns a list of available ticket specifications that can be used when raising new trouble tickets. Each specification defines the structure and expected characteristics for a specific ticket type (e.g., voice quality issue, broadband slow speeds).

The list of supported specifications is centrally maintained, and only a small set of known specification IDs (e.g., Voice-QOS, Broadband-Slow-Speeds) will be supported at any given time. Partners are not expected to call this endpoint dynamically as part of the ticket submission flow. Partners should reference these IDs directly in the troubleTicketSpecification.id field during POST.

Although filtering is supported via query parameters (e.g., lifecycleStatus, version, name), this is intended for offline use (e.g., reference tools or onboarding), not for operational calls on a per-ticket basis, as doing so may negatively impact API performance. Prefix-based filtering (e.g. ‘id starts with Voice-’) is not currently supported. The Voice- and Broadband- prefixes in the id field are naming conventions only, and should not be interpreted as a filterable category.

The response contains high-level metadata for each specification, including id, name, lifecycleStatus, and version, along with an href link for retrieving full details via GET /troubleTicketSpecification/{id}. Specifications marked as active should be used when submitting tickets; retired specifications are for reference only.

Response Shaping (fields Parameter)

The TMF standard defines a fields query parameter to allow clients to limit which fields are included in API responses. However, this parameter is currently not fully supported in the implementation of the Trouble Ticket API.

• Any use of fields in the request of GET /troubleTicketSpecification will be ignored.